Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: small storybook and docs updates to SensitiveText component #28089

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

chore: small storybook and docs updates to SensitiveText component #28089

wants to merge 2 commits into from
+116 −87

Conversation

georgewrmarshall
Copy link
Contributor

@georgewrmarshall georgewrmarshall commented Oct 24, 2024 •
edited by github-actions bot
Loading

Description

This PR updates the Storybook stories for the SensitiveText component to align with extension component library standards. The changes include:

  • Updating Storybook stories to use the CSF 3.0 format for better organization and future-proofing.
  • Converting README.md to README.mdx, leveraging Storybook stories for documentation and improving the accessibility and usability of the component documentation.

Open in GitHub Codespaces

Related issues

Related: #28021

Manual testing steps

  1. Run Storybook locally and navigate to the SensitiveText component.
  2. Verify that the stories render correctly in the CSF 3.0 format.
  3. Check that the new README.mdx renders properly in the Storybook Docs tab.

Screenshots/Recordings

Before

before.mov

After

after.mov

Pre-merge author checklist

Pre-merge reviewer checklist

  • I’ve manually tested the PR (e.g., pulled and built the branch, ran the app, tested the code being changed).
  • I confirm that this PR addresses all acceptance criteria and includes the necessary testing evidence, such as recordings or screenshots.

@georgewrmarshall georgewrmarshall added the team-design-system All issues relating to design system in Extension label Oct 24, 2024
@georgewrmarshall georgewrmarshall self-assigned this Oct 24, 2024
@georgewrmarshall georgewrmarshall requested a review from a team as a code owner October 24, 2024 20:23
@github-actions GitHub Actions
Copy link
Contributor

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

georgewrmarshall
georgewrmarshall commented Oct 24, 2024
View reviewed changes
ui/components/component-library/sensitive-text/README.md
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to README.mdx

@metamaskbot
Copy link
Collaborator

Builds ready [fd8acc7]
Page Load Metrics (2122 ± 101 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint32826412011427205
domContentLoaded18082632208820498
load182226442122210101
domInteractive3210755199
backgroundConnect1094292311
firstReactRender542771395426
getState561212110
initialActions01000
loadScripts13452123158019493
setupStore1298382914
uiStartup205129052428261125
Bundle size diffs
  • background: 0 Bytes (0.00%)
  • ui: 0 Bytes (0.00%)
  • common: 0 Bytes (0.00%)

vinnyhoward
vinnyhoward approved these changes Oct 24, 2024
View reviewed changes
Copy link
Contributor

@vinnyhoward vinnyhoward left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM🫡 Ty for cleaning my mess. Next component I make in the library won't be like this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vinnyhoward vinnyhoward vinnyhoward approved these changes

@garrettbear garrettbear Awaiting requested review from garrettbear

At least 2 approving reviews are required to merge this pull request.

Assignees

@georgewrmarshall georgewrmarshall

Labels
team-design-system All issues relating to design system in Extension
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@georgewrmarshall @metamaskbot @vinnyhoward